|
class EdgeUse |
|
Parent: Entity |
|
|
Methods:edge, face, loop, next, partners, previous, reversed? |
|
|
Sample Code: edgeusetests.rb |
|
The EdgeUse class defines how an Edge is used in the definition of a Face.
|
Instance Methods |
|
edge |
|
The edge method is used to retrieve the edge for the edge use. |
|
Syntax: |
|
edge = edgeuse.edge |
|
Arguments: |
|
|
|
Return Value: |
|
edge - an Edge object used by this edge use |
|
Comments: |
|
|
|
Example: |
|
depth = 100 |
|
face |
|
The face method is used to retrieve the face used by this edge use. |
|
Syntax: |
|
face = edgeuse.face |
|
Arguments: |
|
|
|
Return Value: |
|
face - a Face object used by this edge use |
|
Comments: |
|
|
|
Example: |
|
depth = 100 |
|
loop |
|
The loop method is used to retrieve the loop for this edge use. |
|
Syntax: |
|
loop = edgeuse.loop |
|
Arguments: |
|
|
|
Return Value: |
|
loop - a Loop object that contains this edge use. |
|
Comments: |
|
|
|
Example: |
|
depth = 100 |
|
next |
|
The next method is used to retrieve the next edge use in a loop. |
|
Syntax: |
|
next = edgeuse.next |
|
Arguments: |
|
|
|
Return Value: |
|
next - the next EdgeUse object in a loop |
|
Comments: |
|
|
|
Example: |
|
depth = 100 |
|
partners |
|
The partners method is used to retrieve all of the partner edge uses. This method allows you to find all Faces that use an edge. |
|
Syntax: |
|
partners = edgeuse.partners |
|
Arguments: |
|
|
|
Return Value: |
|
partners - an array of partner Edge Use objects. |
|
Comments: |
|
|
|
Example: |
|
depth = 100 |
|
previous |
|
The previous method is used to retrieve the previous edge use in a loop. |
|
Syntax: |
|
edgeuse = edgeuse.previous |
|
Arguments: |
|
|
|
Return Value: |
|
edgeuse - the previous Edge Use object in the loop |
|
Comments: |
|
|
|
Example: |
|
depth = 100 |
|
reversed? |
|
The reversed? method is used to determine if the edge is reversed in this use. |
|
Syntax: |
|
status = edgeuse.reversed? |
|
Arguments: |
|
|
|
Return Value: |
|
status - true if reversed, false if not reversed. |
|
Comments: |
|
|
|
Example: |
|
depth = 100 |